﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;
using System.Globalization;
using System.Reflection;
using System.Resources;

#region "Custom namespace declarations"

#endregion

namespace Comkarl.Architecture.Patterns.MVC
{
    /// <summary>
    /// Represents the base exception thrown within MVC paradigm.
    /// </summary>
    /// <typeparam name="TIdentifierName">
    /// The type for the instance identifier's name.
    /// </typeparam>
    public abstract class MVCException<TIdentifierName> : PatternInstanceException<TIdentifierName>
        where TIdentifierName : IEquatable<TIdentifierName>
    {
        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="id">
        /// The identifier for the message which is going to be shown.
        /// </param>
        /// <param name="currentInstance">
        /// The instance on which the exception is being thrown.
        /// </param>
        /// <param name="innerException">
        /// An exception which adds more information to the main one.
        /// </param>
        public MVCException(string id, MVCInstance<TIdentifierName> currentInstance, Exception innerException)
            : base(MVCException<TIdentifierName>.GetLocalizedStringByID(id), currentInstance, innerException)
        {
        }

        /// <summary>
        /// Gets the localized string by its identifier.
        /// </summary>
        /// <param name="id">
        /// The identifier for the localized string.
        /// </param>
        /// <returns>
        /// The localized string.
        /// </returns>
        new public static string GetLocalizedStringByID(string id)
        {
            return new ResourceManager("Comkarl.Architecture.Patterns.MVC.Globalization.Localization.MVCExceptionMessages", Assembly.GetExecutingAssembly()).GetString(id, CultureInfo.CurrentCulture);
        }
    }
}
